package com.tedu.weibo.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * @Configuration注解
 * 被该注解标注的类可以作为SpringBoot的配置类使用，它在SpringBoot启动时拥有最优先
 * 的创建，我们可以将其他依赖的框架所需的配置信息在这里进行。
 *
 * @MapperScann注解
 * 是Mybatis提供的注解，用于在Mybatis启动时扫描我们项目中的所有Mapper时使用
 * 一旦这里声明了，那么该包中所有的Mapper接口上就无需再使用@Mapper注解表述了。
 */
@Configuration
@MapperScan("com.tedu.weibo.mapper")
@EnableSwagger2WebMvc
public class Config {
    //配置Swagger2的Docket的Bean实例
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // apiInfo()：配置 API 的一些基本信息，比如：文档标题title，文档描述description，文档版本号version
                .apiInfo(apiInfo())
                // select()：生成 API 文档的选择器，用于指定要生成哪些 API 文档
                .select()
                // apis()：指定要生成哪个包下的 API 文档
                .apis(RequestHandlerSelectors.basePackage("com.tedu.weibo.controller"))
                // paths()：指定要生成哪个 URL 匹配模式下的 API 文档。这里使用 PathSelectors.any()，表示生成所有的 API 文档。
                .paths(PathSelectors.any())
                .build();
    }

    //文档信息配置
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文档标题
                .title("达达微博项目")
                // 文档描述信息
                .description("达达微博项目在线文档")
                // 文档版本号
                .version("1.0")
                .contact(new Contact("蜉蝣","www.tedu","mlyfly@tedu.cn"))
                .build();
    }
}

